home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / separatorclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  2.7 KB  |  194 lines
  1. TABLE OF CONTENTS
  2.  
  3. separatorclass/--background--
  4. separatorclass/SEP_CenterTitle
  5. separatorclass/SEP_Highlight
  6. separatorclass/SEP_Horiz
  7. separatorclass/SEP_Recessed
  8. separatorclass/SEP_Thin
  9. separatorclass/SEP_Title
  10. separatorclass/SEP_TitleLeft
  11. separatorclass/SEP_TitleRight
  12.  
  13. separatorclass/--background--
  14.  
  15. NAME
  16.  
  17.   Class: separatorclass
  18.   Superclass: GADGETCLASS
  19.   Include File: <libraries/bgui.h>
  20.  
  21. FUNCTION
  22.  
  23.   To provide you with a simple way to separate different groups of
  24.   objects with a single 3D line with or without a descriptive title. As
  25.   this class is read-only it will not send out any form of notification.
  26.  
  27. separatorclass/SEP_CenterTitle
  28.  
  29. NAME
  30.  
  31.   SEP_CenterTitle -- ( BOOL )
  32.  
  33. FUNCTION
  34.  
  35.   To render the separator title in the center of the separator bar
  36.   instead of the text baseline on the separator bar. Please note that
  37.   this attribute is only useful and processed for horizontal separators.
  38.  
  39. DEFAULT
  40.  
  41.   FALSE.
  42.  
  43. APPLICABILITY
  44.  
  45.   (I).
  46.  
  47. separatorclass/SEP_Highlight
  48.  
  49. NAME
  50.  
  51.   SEP_Highlight -- ( BOOL )
  52.  
  53. FUNCTION
  54.  
  55.   To render the separator title using the HIGHLIGHTTEXTPEN instead of
  56.   the default TEXTPEN color. Please note that this attribute is only
  57.   useful and processed for horizontal separators.
  58.  
  59. DEFAULT
  60.  
  61.   FALSE.
  62.  
  63. APPLICABILITY
  64.  
  65.   (I).
  66.  
  67. separatorclass/SEP_Horiz
  68.  
  69. NAME
  70.  
  71.   SEP_Horiz -- ( BOOL )
  72.  
  73. FUNCTION
  74.  
  75.   To make the separator a horizontal one. By default the separator is
  76.   vertical. Vertical separators must be used in horizontal groups and
  77.   horizontal separators in vertical groups.
  78.  
  79. DEFAULT
  80.  
  81.   FALSE.
  82.  
  83. APPLICABILITY
  84.  
  85.   (I).
  86.  
  87. separatorclass/SEP_Recessed
  88.  
  89. NAME
  90.  
  91.   SEP_Recessed -- ( BOOL ) ** V39 **
  92.  
  93. FUNCTION
  94.  
  95.   To make the separator appear recessed.
  96.  
  97. DEFAULT
  98.  
  99.   FALSE.
  100.  
  101. APPLICABILITY
  102.  
  103.   (I).
  104.  
  105. separatorclass/SEP_Thin
  106.  
  107. NAME
  108.  
  109.   SEP_Thin -- ( BOOL )
  110.  
  111. FUNCTION
  112.  
  113.   To make the separator thin which means that the width of the bar is
  114.   reduced to two pixels. Please note that this attribute is only useful
  115.   and processed for vertical separators.
  116.  
  117. DEFAULT
  118.  
  119.   FALSE.
  120.  
  121. APPLICABILITY
  122.  
  123.   (I).
  124.  
  125. separatorclass/SEP_Title
  126.  
  127. NAME
  128.  
  129.   SEP_Title -- ( STRPTR )
  130.  
  131. FUNCTION
  132.  
  133.   To give the separator a descriptive title. Please note that this
  134.   attribute is only useful and processed for horizontal separators.
  135.  
  136.   This title may contain infoclass command sequences.  ** V41 **
  137.   
  138. DEFAULT
  139.  
  140.   NULL.
  141.  
  142. APPLICABILITY
  143.  
  144.   (I).
  145.  
  146. SEE ALSO
  147.  
  148.   infoclass.doc/INFO_TextFormat
  149.  
  150. separatorclass/SEP_TitleLeft
  151.  
  152. NAME
  153.  
  154.   SEP_TitleLeft -- ( BOOL ) ** V40 **
  155.  
  156. FUNCTION
  157.  
  158.   To make the title of the separator stick to the left side.
  159.  
  160. DEFAULT
  161.  
  162.   FALSE.
  163.  
  164. APPLICABILITY
  165.  
  166.   (I).
  167.  
  168. SEE ALSO
  169.  
  170.   SEP_TitleRight
  171.  
  172. separatorclass/SEP_TitleRight
  173.  
  174. NAME
  175.  
  176.   SEP_TitleRight -- ( BOOL ) ** V40 **
  177.  
  178. FUNCTION
  179.  
  180.   To make the title of the separator stick to the right side.
  181.  
  182. DEFAULT
  183.  
  184.   FALSE.
  185.  
  186. APPLICABILITY
  187.  
  188.   (I).
  189.  
  190. SEE ALSO
  191.  
  192.   SEP_TitleLeft
  193.  
  194.